home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / x2ftp / msdos / utils / hdk115l / hdklib.doc < prev    next >
Text File  |  1994-04-12  |  15KB  |  336 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                               HyperAct, Inc.                             ║
  5.  ║                               P.O.Box. 5517                              ║
  6.  ║                         Coralville IA 52241 U.S.A                        ║
  7.  ║                          Compuserve - 76350,333                          ║
  8.  ║                        Phone/Fax - (319) 351-8413                        ║
  9.  ║                                                                          ║
  10.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  11.  
  12. *******************************************************************************
  13. *                                   HDKLIB                                    *
  14. * HLPDK V11.5+ System Library Documentation.                                  *
  15. * Last Update - Feb. 11, 1994. (c) 1993, 94 HyperAct Inc.                     *
  16. * Author : Ron Loewy                                                          *
  17. *******************************************************************************
  18.  
  19.  HLPDK System Extention Library.
  20.  
  21.  "Write Once, Help Many!"
  22.       
  23. *******************************************************************************
  24. *                                Introduction                                 *
  25. *******************************************************************************
  26.  
  27. HDKLIB is an extention library to HLPDK that adds functionality to
  28. the HLPDK package, by including special "User Link Templates" that add support
  29. for special links, special graphics, enhanced text attributes and more.
  30.  
  31. HDKLIB uses the HLPDK .USERLINK statement to add functionality to the HLPDK
  32. system, and offer simple methods to create graphic links, normal text links,
  33. 256 color bitmap support, video, CDAudio, Multimedia MCI interface etc ..
  34.  
  35. WINHELP users have access to the complete macro API, using !xxx user links.
  36.  
  37. The UNDOCUMENTED WINHELP macros are supported as well!
  38.  
  39. *******************************************************************************
  40. *                                  Warranty                                   *
  41. *******************************************************************************
  42.  
  43. There is no warranty what so ever, The package is supplied as is,
  44. The distributor (HyperAct Inc.), or the author (Loewy Ron), are not, 
  45. and will not be responsible for any damages, lost profits, 
  46. or inconveniences caused by the use, or inability to use this package. 
  47. The use of the program is at your own risk. 
  48. By using (or attempting to use) the package you agree to this.
  49.  
  50. *******************************************************************************
  51. *                                Distribution                                 *
  52. *******************************************************************************
  53.  
  54. HDKLIB is free to registered users of HLPDK. If you are not a HLPDK registered
  55. user, you are allowed to evaluate HLPDK and HDKLIB for a reasonable amount of
  56. time (Up to 1 Month).
  57.  
  58. Please consult the HLPDK.DOC and HLPDK.REG files that come with the evaluation
  59. package of HLPDK.
  60.  
  61. *******************************************************************************
  62. *                                   Contact                                   *
  63. *******************************************************************************
  64.  
  65. Please contact :
  66.  
  67.         HyperAct Inc.  
  68.         P.O.Box 5517
  69.         Coralville IA 52241
  70.         U.S.A
  71.  
  72.         E-Mail  : Compuserve - 76350,333
  73.         Phone   : (319) 351-8413
  74.            
  75. To contact the author directly please write to : 
  76.  
  77.         Loewy Ron
  78.  
  79.         E-Mail  : Compuserve - 100274,162
  80.  
  81. *******************************************************************************
  82. *                                    Setup                                    *
  83. *******************************************************************************
  84.  
  85. Copy the files to the directory you use to keep HLPDK.
  86.  
  87. Every help/hypertext/hypermedia database you use with HDKLIB should include
  88. a line of the format :
  89.  
  90. .include [d:\path\to\hdklib-directory\]HDKLIB.HDF
  91.  
  92. and all the HDKLIB functions are available.
  93.  
  94. *******************************************************************************
  95. *                                  Operation                                  *
  96. *******************************************************************************
  97.  
  98. After you have .INCLUDEd the HDKLIB.HDF library in your HDF source, you
  99. can use the following NEW functions and templates :
  100.  
  101. winHelp
  102. -------
  103.  
  104. Text Attributes :
  105.  
  106. boldText        - Display Text in Bold.     ~Text to display~boldText~
  107. italicText      - Display Text in Italic    ~Text to display~italicText~
  108. underlineText   - Display Text underlined   ~Text to display~underlineText~
  109. boldItalicText  - Display Bold Italic Text  ~Text to display~boldItalicText~
  110. fontText        - Display Text in font X    ~Text in font 3~fontText(3)~
  111.  
  112. Topics :
  113.  
  114. dropContext     - set a context in text     ~myContext~dropContext~
  115.  
  116. You can later jump to the context point using the !jumpID macro.
  117.  
  118. Links :
  119.  
  120. NormalTextLink  - Link not underlined       ~Click Here~NormalTextLink(linkId)~
  121. NormalTextPopup - Popup not underlined      ~Click Here~NormalTextPopup(popupId)~
  122.  
  123. graphicLink     - Link connected to bitmap  ~Text~graphicLink(myBmp LinkId)~
  124.                   Should declare a .GRAPHIC myBmp c:\..\myfile.bmp
  125. graphicPopup    - Popup connected to bitmap ~Text~graphicPopup(myBmp PopupId)
  126.                   Should declared a .GRAPHIC myBmp c:\..\myfile.bmp
  127.  
  128.  
  129. Macros :
  130.  
  131. Complete WINHELP macro API reference is provided, if there is a macro such
  132. as the About() WINHELP macro, you can rfer to it with the !about user link.
  133.  
  134. e.g. - Using the ExecProgram WINHELP macro, to start NOTEPAD.EXE in minimized
  135.        mode can be used with !execProgram(notepad.exe 2)
  136.  
  137. For the complete macro reference, please consult the WINHELP macro 
  138. documentation in the programming reference guide that came with your
  139. development package, or the Microsoft WHAG package.
  140.  
  141. WINHELP Macros Quick Referece -
  142.  
  143. About                - Displays the About dialog box 
  144.                       e.g. ~text~!about~      
  145. AddAccelerator        - Assigns a macro to an accelerator key 
  146.                       e.g. ~text~!addAccelerator(0x73 7 'About()')~
  147. Annotate        - Displays Annotation dialog box 
  148.                       e.g. ~text~!annotate~
  149. AppendItem        - Appends a menu item 
  150.                       e.g. ~text~!appendItem(ID_MENU ID_ITEM &Item 'JI("","TOP")'~
  151. Back                - Displays previous topic in the history list 
  152.                       e.g. ~text~!back~
  153. BookmarkDefine        - Displays the Define dialog box 
  154.                       e.g. ~text~!bookmarkDefine~
  155. BookmarkMore        - Displays the More dialog box 
  156.                       e.g. ~text~!bookmarkMore~
  157. BrowseButtons        - Adds browse buttons 
  158.                       e.g. ~text~!browseButtons~
  159. ChangeButtonBinding - Assigns a macro to a button 
  160.                       e.g. ~text~!ChangeButtonBinding(btn_contents 'JI("","NEWTOP")')~
  161. ChangeItemBinding   - Assigns a macro to a menu item 
  162.                       e.g. ~text~!changeItemBinding(DISP_ABOUT About())~
  163. CheckItem        - Checks a menu item 
  164.                       e.g. ~text~!checkItem(ID_ITEM)~
  165. CloseWindow        - Closes a window 
  166.                       e.g. ~text~!closeWindow(ID_WIN)~
  167. Contents        - Displays the Contents topic                             
  168.                       e.g. ~text~!contents~
  169. CopyDialog        - Displays the Copy dialog box 
  170.                       e.g. ~text~!copyDialog~
  171. CopyTopic        - Copies current topic to the clipboard 
  172.                       e.g. ~text~!copyTopic~
  173. CreateButton        - Adds a new button to the button bar 
  174.                       e.g. ~text~!createButton(ID_BUTTON BUT_NAME JI("","TOP")~
  175. DeleteItem        - Removes a menu item 
  176.                       e.g. ~text~!deleteItem(ID_ITEM)~
  177. DeleteMark        - Deletes a text marker 
  178.                       e.g. ~text~!deleteMark(Marker)~
  179. DestroyButton        - Removes a button from the button bar 
  180.                       e.g. ~text~!destroyButton(ID_BUTTON)~
  181. DisableButton        - Disables a button 
  182.                       e.g. ~text~!disableButton(ID_BUTTON)~
  183. DisableItem        - Disables a menu item 
  184.                       e.g. ~text~!disableItem(ID_ITEM)~
  185. EnableButton        - Enables a button 
  186.                       e.g. ~text~!enableButton(ID_BUTTON)~
  187. EnableItem        - Enables a menu item 
  188.                       e.g. ~text~!enableItem(ID_ITEM)~
  189. ExecProgram        - Executes a program 
  190.                       e.g. ~text~!execProgram(clock.exe 0)~
  191. Exit                - Exits  
  192.                       e.g. ~text~!exit~
  193. FileOpen        - Displays the Open dialog box 
  194.                       e.g. ~text~!fileOpen~
  195. FocusWindow        - Changes the focus window 
  196.                       e.g. ~text~!focusWindow(ID_WIN)~
  197. GoToMark            - Jumps to a marker 
  198.                       e.g. ~text~!gotoMark(MARKER)~
  199. HelpOn                - Displays the Help on Using topic 
  200.                       e.g. ~text~!helpOn~
  201. HelpOnTop           - Toggles on-top state of help 
  202.                       e.g. ~text~!helpOnTop~
  203. History                - Displays the history list 
  204.                       e.g. ~text~!history~
  205. IfThen                - Executes macro if marker exists 
  206.                       e.g. ~text~!ifThen(MARKER 'JI("","TOP")')~
  207. IfThenElse        - Executes one of two macros if marker exists 
  208.                       e.g. ~text~!ifThenElse(Marker MACROTRUE MACROFALSE)~
  209. InsertItem        - Inserts a menu item 
  210.                       e.g. ~text~!insertItem(ID_MENU ID_ITEM &Item MACRO 3)~
  211. InsertMenu        - Inserts a new menu 
  212.                       e.g. ~text~!insertMenu(ID_MENU &Menu 2)~
  213. IsMark                - Tests if a marker is set 
  214.                       e.g. ~text~!ismark(MARKER)~
  215. JumpContents        - Jumps to the Contents topic
  216.                       e.g. ~text~!JumpContents(FILENAME)~ 
  217. JumpContext        - Jumps to the specified context 
  218.                       e.g. ~text~jumpContext(FILENAME TOP_ID)~
  219. JumpHelpOn        - Jumps to Using Help file 
  220.                       e.g. ~text~!jumpHelpOn~
  221. JumpId                - Jumps to the specified topic 
  222.                       e.g. ~text~!jumpId(FILENAME TOP_NAME)~
  223. JumpKeyword         - Jumps to the topic containing the keyword 
  224.                       e.g. ~text~!jumpKeyword(FILENAME KEYWORD)~
  225. Next                - Displays the next topic in the browse sequence 
  226.                       e.g. ~text~!next~
  227. Not                - Reverses the IsMark macro 
  228.                       e.g. ~text~!not(MARKER)~
  229. PopupContext        - Displays a topic in a popup window 
  230.                       e.g. ~text~!popupContext(FILENAE POPUP_ID)~
  231. PopupId                - Displays topic in a popup window 
  232.                       e.g. ~text~!popupId(FILENAE POPUP_NAME)~
  233. PositionWindow        - Sets the size and position of a window 
  234.                       e.g. ~text~!positionWindow(x y w h state ID_WIN)~
  235. Prev                - Displays previous topic in browse sequence 
  236.                       e.g. ~text~!prev~
  237. Print                - Prints the current topic 
  238.                       e.g. ~text~!print~
  239. PrinterSetup        - Displays the Printer Setup dialog box 
  240.                       e.g. ~text~!printerSetup~
  241. RegisterRoutine        - Registers a DLL function 
  242.                       e.g. ~text~!registerRoutine(DLL FUNC PARAMETERS)~
  243. RemoveAccelerator   - Assigns a macro to an accelerator key 
  244.                       e.g. ~text~!removeAccelerator(KEY SHIFT_STATE)~
  245. SaveMark        - Saves a marker 
  246.                       e.g. ~text~!saveMark(MARKER)~
  247. Search                - Displays the Search dialog box 
  248.                       e.g. ~text~!search~
  249. SetContents         - Sets the Contents topic 
  250.                       e.g. ~text~!setContents(FILENAME TOP_ID)~
  251. SetHelpOnFile        - Sets the Using Help help file 
  252.                       e.g. ~text~!setHelpOnFile(FILENAME)~
  253. UncheckItem        - Unchecks a menu item 
  254.                       e.g. ~text~!uncheckItem(ID_ITEM)~
  255.  
  256. Undocumented :
  257.  
  258. ExtAbleItem         - Enable and Disable the menu_item, with
  259.                       toggle 0 = Enable, toggle 1 = Disable.    
  260.  
  261. ExtInsertItem       - Same as InsertItem, but with one additional parameter that
  262.                       allows you to set the menu state initially to enable or     
  263.                       disable state. 0 = Enable, 1 = Disable                      
  264.                       Notice that the 1st parameter in this macro allows you to   
  265.                       set sub-menus in menus, a thing that can not be achieved    
  266.                       with the documented winhelp macros.
  267.  
  268. FloatingMenu        - Call the floating menu, that has been created with the
  269.                       routines and the mnu_floating undocumented menu id.
  270.  
  271. ResetMenu           - Restore's the winhelp standard menu.
  272.  
  273. JumpHash, PopupHash - Jump according to the internal hash id.
  274.  
  275. Multimedia :
  276.  
  277. Interface to the MCI String Command interface, with support for VfW AVI Video
  278. files, CDAudio, and any MCI String for any MultiMedia device supported by MCI.
  279.  
  280. videoLink           - Play AVI video.
  281.                       e.g. ~text~videoLink(MOVIE.AVI)~
  282. CDAudioLink         - Play a range of CDAudio tracks (From, To)
  283.                       e.g. ~text~CDAudioLink(5 7)~
  284. mciStringLink       - Send a genric MCI String command
  285.                       e.g. ~text~mciStringLink('open sequenced!mymusic.mid alias music')~
  286.  
  287. Multimedia Viewer
  288. -----------------
  289.  
  290. Text Attributes : Same as winHelp
  291. Topics          : Same as winHelp
  292. Links           : Same as winHelp
  293. Macros          : Same as winHelp
  294. MultiMedia      : Interface to MCI String commands, as in WINHELP.
  295.  
  296. 256 Bitmaps :
  297.  
  298. bmp256, bmp256Left, bmp256Right - Display 256 color bitmap in an embedded pane.
  299. Gbmp256, Gbmp256Left and Gbmp256Right - are the same, but associate bitmaps
  300.                                         defined in .graphic command.
  301. Ebmp256, Ebmp256Left, EbmpRight - are the same, but for graphics defined
  302.                                   in .embedd commands. This is the prefered
  303.                                   method for MM Viewer!
  304.  
  305. RTF Word Processors
  306. -------------------
  307.  
  308. Text Attributes : Same as winHelp
  309.  
  310. IPF (OS/2)
  311. ----------
  312.  
  313. IPF extention need HLPDK V11.0 or later, Version 10.0 is NOT enough.
  314.  
  315. Text Attributes :
  316.  
  317. boldText        - Display Text in Bold.     ~Text to display~boldText~
  318. italicText      - Display Text in Italic    ~Text to display~italicText~
  319. underlineText   - Display Text underlined   ~Text to display~underlineText~
  320. boldItalicText  - Display Bold Italic Text  ~Text to display~boldItalicText~
  321.  
  322. Links :
  323. graphicLink     - Link connected to bitmap  ~Text~graphicLink(myBmp LinkId)~
  324.                   Should declare a .GRAPHIC myBmp c:\..\myfile.bmp
  325.  
  326.  
  327. HTML (WWW)
  328. ----------
  329.  
  330. Text Attributes :
  331.  
  332. boldText        - Display Text in Bold.     ~Text to display~boldText~
  333. italicText      - Display Text in Italic    ~Text to display~italicText~
  334. boldItalicText  - Display Bold Italic Text  ~Text to display~boldItalicText~
  335.  
  336.